| Current File : /var/www/e360ban/wp-content/plugins/wp-views/embedded/inc/functions-core-embedded.php |
<?php
/**
* wpv_check_views_exists
*
* Checks the existence of Views given a query mode.
*
* @param (string|array) $query_mode Kind of View object: 'normal' or 'archive' (or 'layouts-loop').
* @param $args = array(
* @param $args['status'] (array|false) the View status to be counted, if needed
* @param $args['orderby'] (string|false) the sorting order, if needed
*
* @return (array|false) array of View IDs or false
*
* @since unknown
*/
function wpv_check_views_exists( $query_mode, $args = array() ) {
$defaults = array(
'post_status' => false,
'orderby' => false
);
$args = wp_parse_args( $args, $defaults );
$all_views_ids = _wpv_get_all_view_ids( $query_mode, $args );
if ( count( $all_views_ids ) != 0 ) {
return $all_views_ids;
} else {
return false;
}
}
/**
* _wpv_get_all_view_ids
*
* Get the IDs for all Views of a kind of View (normal or archive)
*
* @param string|array $view_query_mode Kind of View object: 'normal' or 'archive' (or 'layouts-loop').
* @param $args = array(
* @param $args['status'] (array|false) the View status to be counted, if needed
* @param $args['orderby'] (string|false) the sorting order, if needed
* )
*
* @return array() of relevant Views if they exists or empty array if not
*
* @since unknown
*/
function _wpv_get_all_view_ids( $view_query_mode, $args = array() ) {
global $wpdb;
$view_status_string = "";
$order_by_string = "";
$post_type = 'view';
$defaults = array(
'post_status' => false,
'orderby' => false
);
$values_to_prepare = array();
$args = wp_parse_args( $args, $defaults );
$values_to_prepare[] = $post_type;
if ( $args['post_status'] ) {
$view_stati = is_array( $args['post_status'] ) ? $args['post_status'] : array( $args['post_status'] );
$view_stati_count = count( $view_stati );
$view_stati_placeholders = array_fill( 0, $view_stati_count, '%s' );
$view_status_string = " AND post_status IN (" . implode( ",", $view_stati_placeholders ) . ")";
foreach ( $view_stati as $view_st ) {
$values_to_prepare[] = $view_st;
}
}
if ( $args['orderby'] ) {
$orderby = $args['orderby'];
$order_by_string = " ORDER BY %s";
$values_to_prepare[] = $orderby;
}
$all_views = $wpdb->get_results(
$wpdb->prepare(
"SELECT ID FROM {$wpdb->posts}
WHERE post_type = %s
{$view_status_string}
{$order_by_string}",
$values_to_prepare
)
);
$view_ids = array();
$view_query_mode = is_array( $view_query_mode ) ? $view_query_mode : array( $view_query_mode );
foreach ( $all_views as $key => $view ) {
$settings = apply_filters( 'wpv_filter_wpv_get_object_settings', array(), $view->ID );
if ( ! in_array( $settings['view-query-mode'], $view_query_mode ) ) {
unset( $all_views[$key] );
} else {
$view_ids[] = $view->ID;
}
}
return $view_ids;
}
/**
* Counts the amount of posts of a given type that do not use a given Template and creates the HTML structure to notify about it
* Used on the Views popups for the Content Templates listing page on single usage
*
* @param int $template_id the ID of the Content Template we want to check against
* @param string $content_type the post type to check
* @param string $message_header (optional) to override the default message on the HTML structure header "Do you want to apply to all?"
*
* @return void
*
* @since 1.5.1
*
* @deprecated since 1.10
*/
function wpv_count_dissident_posts_from_template( $template_id, $content_type, $message_header = null ) {
try {
$ct = new WPV_Content_Template_Embedded( $template_id );
} catch( Exception $e ) {
// well, we were not handling non-existent CTs before and I am not sure how to do that now...
return;
}
$dissident_post_count = $ct->get_dissident_posts( $content_type, 'count' );
if ( $dissident_post_count > 0 ) {
$ptype = get_post_type_object( $content_type );
if ( $dissident_post_count > 1 ){
$type_label = $ptype->labels->name;
$message = sprintf( __( '<strong>%d %s</strong> use a different Content Template.', 'wpv-views' ), $dissident_post_count , $type_label );
} else {
$type_label = $ptype->labels->singular_name;
$message = sprintf(__('<strong>%d %s</strong> uses a different Content Template.', 'wpv-views'), $dissident_post_count, $type_label);
}
?>
<div class="wpv-dialog wpv-shortcode-gui-content-wrapper">
<?php echo $message; ?>
</div>
<?php
}
}
/**
* wpv_update_dissident_posts_from_template
*
* Updates all the of posts of a given type to use a given Template and creates the HTML structure to notify about it
* Used on the Views popups for the Content Templates listing page on single usage and for the Template edit screen
*
* @param int $template_id the ID of the Content Template we want to check against
* @param string $content_type the post type to check
* @param bool $echo If set to false, no HTML template for a dialog will be rendered. Default is true.
*
* @deprecated - In the new mechanism there are no dissident posts, those are specific posts.
*
* @since 1.5.1
*/
function wpv_update_dissident_posts_from_template( $template_id, $content_type, $echo = true ) {
global $wpdb;
$posts = $wpdb->get_col(
$wpdb->prepare(
"SELECT {$wpdb->posts}.ID FROM {$wpdb->posts}
WHERE post_type = %s",
$content_type
)
);
$count = sizeof( $posts );
$updated_count = 0;
if ( $count > 0 ) {
foreach ( $posts as $post ) {
$template_selected = get_post_meta( $post, '_views_template', true );
if ( $template_selected != $template_id ) {
WPV_Content_Template_Embedded::assign_ct_to_post_object( $post, $template_id, $template_selected );
$updated_count += 1;
}
}
}
if( $echo ) {
echo '<div class="wpv-dialog wpv-dialog-change js-wpv-dialog-change">
<div class="wpv-dialog-header">
<h2>' . __('Success!', 'wpv-views') . '</h2>
</div>
<div class="wpv-dialog-content">
<p>' . sprintf(__('All %ss were updated', 'wpv-views'), $content_type) . '</p>
</div>
<div class="wpv-dialog-footer">
<button class="button-secondary js-dialog-close">' . esc_js(__('Close', 'wpv-views')) . '</button>
</div>
</div>';
}
}
/**
* Counts the number of different parametric searches by kind (tax, cf, pr)
*
* @param $view_settings
*
* @return array $return
* $return['pr'] = 0;
* $return['cf'] = 0;
* $return['tax'] = 0;
* $return['search'] = 0;
* $return['warning'] = There is something wrong, but keep going
* $return['error'] = This view does not allow parametric searches
*
* @since 1.6.0
* @since 2.3.0 Added support for recognizing filter shorcodes using single quotes for attribute values.
* @since 2.4.0 Added support for recognizing the new wpv-control-post-taxonomy, wpv-control-postmeta and wpv-control-post-relationship shortcodes.
*/
function wpv_count_filter_controls( $view_settings ) {
$return = array();
$return['pr'] = 0;
$return['cf'] = 0;
$return['tax']= 0;
$return['search'] = 0;
if (
! isset( $view_settings['filter_meta_html'] )
|| empty( $view_settings['filter_meta_html'] )
) {
$return['error'] = __('Filter MetaHTML is empty', 'wpv-views');
return $return;
}
$filter_controls_by_tag = substr_count( $view_settings['filter_meta_html'], '[wpv-control ' );
$filter_controls_by_tag += substr_count( $view_settings['filter_meta_html'], '[wpv-control-set ' );
$filter_controls_by_tag += substr_count( $view_settings['filter_meta_html'], '[wpv-filter-search-box' );
$filter_controls_by_tag += substr_count( $view_settings['filter_meta_html'], '[wpv-control-post-taxonomy ' );
$filter_controls_by_tag += substr_count( $view_settings['filter_meta_html'], '[wpv-control-postmeta ' );
$filter_controls_by_tag += substr_count( $view_settings['filter_meta_html'], '[wpv-control-post-relationship ' );
if ( ! isset( $view_settings['filter_controls_mode'] ) ) {
$view_settings['filter_controls_mode'] = array();
}
if ( ! is_array( $view_settings['filter_controls_mode'] ) ) {
$return['error'] = __('Something on the filter_controls_mode is broken', 'wpv-views');
}
$return['missing'] = array();
foreach ( $view_settings as $v_key => $v_val ) {
if ( $v_key == 'post_relationship_mode' && is_array( $v_val ) && in_array( 'url_parameter', $v_val ) ) {
$return['pr'] = 1;
if (
substr_count( $view_settings['filter_meta_html'], '[wpv-control-set ' ) !== 1
&& substr_count( $view_settings['filter_meta_html'], '[wpv-control-post-relationship ' ) !== 1
) {
$return['missing'][] = array(
'type' => 'rel',
'name' => __( 'post relationship', 'wpv-views' )
);
}
} else if ( strpos( $v_key, 'custom-field-' ) === 0 && strpos( $v_key, '_value' ) === strlen( $v_key ) - strlen( '_value' ) && strpos( $v_val, 'URL_PARAM' ) !== false ) {
$return['cf'] += substr_count( $v_val, 'URL_PARAM' );
$v_array = explode( ',', $v_val );
foreach ( $v_array as $v_candidate) {
$v_candidate = trim( $v_candidate );
if ( substr_count( $v_candidate, 'URL_PARAM' ) > 0 ) {
$v_url = substr( $v_candidate, 10, -1 );
if (
substr_count( stripslashes( $view_settings['filter_meta_html'] ), 'url_param="' . $v_url . '"' ) !== 1
&& substr_count( stripslashes( $view_settings['filter_meta_html'] ), "url_param='" . $v_url . "'" ) !== 1
) {
$return['missing'][] = array(
'type' => 'cf',
'name' => substr( $v_key, 13, -6 )
);
}
}
}
} else if ( strpos( $v_key, 'tax_' ) === 0 && strpos( $v_key, '_relationship' ) === strlen( $v_key ) - strlen( '_relationship' ) && $v_val == 'FROM URL' ) {
$return['tax'] += 1;
$tax_name = substr( $v_key, 4, -13 );
if (
substr_count( stripslashes( $view_settings['filter_meta_html'] ), 'taxonomy="' . $tax_name . '"' ) !== 1
&& substr_count( stripslashes( $view_settings['filter_meta_html'] ), "taxonomy='" . $tax_name . "'" ) !== 1
) {
$return['missing'][] = array(
'type' => 'tax',
'name' => $tax_name
);
}
} else if ( $v_key == 'search_mode' && !( isset( $view_settings['search_mode'][0] ) && $view_settings['search_mode'][0] == 'shortcode' ) ) {
$return['search'] = 1;
if (
substr_count( $view_settings['filter_meta_html'], '[wpv-filter-search-box' ) !== 1
&& substr_count( $view_settings['filter_meta_html'], 'url_param="wpv_post_search"' ) !== 1
&& substr_count( $view_settings['filter_meta_html'], "url_param='wpv_post_search'" ) !== 1
) {
$return['missing'][] = array(
'type' => 'search',
'name' => __( 'post search', 'wpv-views' )
);
}
}
}
if ( $filter_controls_by_tag < $return['pr'] + $return['cf'] + $return['tax'] + $return['search'] ) {
// Something went wrong! There are filters using another key...
$return['warning'] = __('Your View contains more URL based filters than custom search controls in the Filter HTML textarea', 'wpv-views');
} else if ( $filter_controls_by_tag > $return['pr'] + $return['cf'] + $return['tax'] + $return['search'] ) {
$return['warning'] = __('Your View contains more custom search controls in the Filter HTML textarea than URL based filters', 'wpv-views');
}
return $return;
}
/**
* wpv_types_get_field_type
*
* Get the Types type of a given custom field
*
* @param $field_name (string) the field meta_key
*
* @param string $field_type
*
* @return string (string) the field type if any or an empty string if not
*/
function wpv_types_get_field_type( $field_name, $field_type = 'cf' ) {
switch ( $field_type ) {
case 'tf':
$option_slug = 'wpcf-termmeta';
break;
case 'uf':
$option_slug = 'wpcf-usermeta';
break;
case 'cf':
default:
$option_slug = 'wpcf-fields';
break;
}
$types_field_type = '';
if ( ! empty( $field_name ) ) {
$opt = get_option( $option_slug, array() );
if (
$opt
&& ! empty( $opt )
) {
if ( strpos( $field_name, 'wpcf-' ) === 0 ) {
$field_name = substr( $field_name, 5 );
}
if (
isset( $opt[$field_name] )
&& is_array( $opt[$field_name] )
&& isset( $opt[$field_name]['type'] )
) {
$types_field_type = strtolower( $opt[$field_name]['type'] );
}
}
}
return $types_field_type;
}
/**
* wpv_types_get_field_name
*
* Get the Types name of a given custom field
*
* @param $field_name (string) the field meta_key
*
* @param string $field_type
*
* @return (string) the Types field name if any or the same $field_name if not
*
* @since 1.8.0
* @since 2.5.2 Strip slashes from Types fields titles, as WordPress adds them automatically on fields save.
*/
function wpv_types_get_field_name( $field_name, $field_type = 'cf' ) {
$field_nicename = $field_name;
switch ( $field_type ) {
case 'tf':
$option_slug = 'wpcf-termmeta';
break;
case 'uf':
$option_slug = 'wpcf-usermeta';
break;
case 'cf':
default:
$option_slug = 'wpcf-fields';
break;
}
if ( ! empty( $field_name ) ) {
$opt = get_option( $option_slug, array() );
if (
$opt
&& ! empty( $opt )
) {
if ( strpos( $field_name, 'wpcf-' ) === 0 ) {
$field_name = substr( $field_name, 5 );
}
if (
isset( $opt[$field_name] )
&& is_array( $opt[$field_name] )
&& isset( $opt[$field_name]['name'] )
) {
$field_nicename = $opt[$field_name]['name'];
$field_nicename = stripslashes( $field_nicename );
}
}
}
return $field_nicename;
}
/**
* wpv_types_get_field_real_slug
*
* MAKES _wpv_get_field_real_slug DEPRECATED and DUPLICATED
*
* Check if a field is a Types one and return its real slug, the passed slug otherwise
*
* @param $field_name (string) the field name
*
* @param string $field_type
*
* @return (string)
*
* @since 1.10
*
*/
function wpv_types_get_field_real_slug( $field_name, $field_type = 'cf' ) {
$real_slug = $field_name;
switch ( $field_type ) {
case 'tf':
$option_slug = 'wpcf-termmeta';
break;
case 'uf':
$option_slug = 'wpcf-usermeta';
break;
case 'cf':
default:
$option_slug = 'wpcf-fields';
break;
}
$opt = get_option( $option_slug, array() );
if (
$opt
&& ! empty( $opt )
) {
if ( strpos( $field_name, 'wpcf-' ) === 0 ) {
$field_name = substr( $field_name, 5 );
}
if (
isset( $opt[$field_name] )
&& is_array( $opt[$field_name] )
&& isset( $opt[$field_name]['meta_key'] )
) {
$real_slug = $opt[$field_name]['meta_key'];
}
}
return $real_slug;
}
/**
* Get the whole Types data attibutes for a field, given its slug.
*
* @param $field_name string The field slug
* @param $domain string The field domain, can be 'postmeta'|'cf', ' termmeta'|'tf', or 'usermeta'|'uf'
*
* @return array
*
* @note This should deprecate the usage of wpv_types_get_field_type, wpv_types_get_field_name, wpv_types_get_field_real_slug, wpv_is_types_custom_field
*
* @since 2.4.0
*/
function wpv_types_get_field_data( $field_name, $domain = 'postmeta' ) {
$data = array();
switch ( $domain ) {
case 'tf':
case 'termmeta':
$option_slug = 'wpcf-termmeta';
break;
case 'uf':
case 'usermeta':
$option_slug = 'wpcf-usermeta';
break;
case 'cf':
case 'postmeta':
default:
$option_slug = 'wpcf-fields';
break;
}
if ( ! empty( $field_name ) ) {
$opt = get_option( $option_slug, array() );
if (
$opt
&& ! empty( $opt )
) {
if ( strpos( $field_name, 'wpcf-' ) === 0 ) {
$field_name = substr( $field_name, 5 );
}
if (
isset( $opt[ $field_name ] )
&& is_array( $opt[ $field_name ] )
) {
$data = $opt[ $field_name ];
}
}
}
return $data;
}
/**
* wpv_is_types_custom_field
*
* Checks whether the provided key corresponds to a Types custom field, and returns its data if any
*
* @param $field_name string
*
* @param string $field_type
*
* @return array|bool
* @since 1.9
*/
function wpv_is_types_custom_field( $field_name, $field_type = 'cf' ) {
$is_types_field = false;
switch ( $field_type ) {
case 'tf':
$option_slug = 'wpcf-termmeta';
break;
case 'uf':
$option_slug = 'wpcf-usermeta';
break;
case 'cf':
default:
$option_slug = 'wpcf-fields';
break;
}
if ( ! empty( $field_name ) ) {
$opt = get_option( $option_slug, array() );
if (
$opt
&& ! empty( $opt )
) {
if ( strpos( $field_name, 'wpcf-' ) === 0 ) {
$field_name = substr( $field_name, 5 );
}
if ( isset( $opt[$field_name] ) ) {
$is_types_field = $opt[$field_name];
}
}
}
return $is_types_field;
}
/**
* wpv_esc_like
*
* In WordPress 4.0, like_escape() was deprecated, due to incorrect documentation and improper sanitization leading to a history of misuse
* To maintain compatibility with versions of WP before 4.0, we duplicate the logic of the replacement, wpdb::esc_like()
*
* @since 1.6.2
*
* @see wpdb::esc_like() for more details on proper use.
*
* @param string $text The raw text to be escaped.
* @return string Text in the form of a LIKE phrase. Not SQL safe. Run through wpdb::prepare() before use.
*/
function wpv_esc_like( $text ) {
global $wpdb;
if ( method_exists( $wpdb, 'esc_like' ) ) {
return $wpdb->esc_like( $text );
} else {
return like_escape( esc_sql( $text ) );
}
}
/**
* wpv_compat_get_split_term
*
* In WordPress 4.2, wp_get_split_term() was introduced to get the new term_id for a term that had been splitted
* because its term_id was shared across several taxonomies
*
* @since 1.8.0
*
* @param int $term_id The term_id to check
* @param string $taxonomy The taxonomy to get the term_id from
-*
* @return bool|int The new term_id if it has changed and the function is available, false otherwise
*/
function wpv_compat_get_split_term( $term_id, $taxonomy ) {
if ( function_exists( 'wp_get_split_term' ) ) {
return wp_get_split_term( $term_id, $taxonomy );
} else {
return false;
}
}
/**
* Render a "toolset-alert-error" message and die.
*
* Renders a properly wrapped error message. Created to reduce code redundancy.
*
* @param string $message Text of the message to be rendered.
*
* @since 1.7
*/
function wpv_die_toolset_alert_error( $message ) {
wp_die( sprintf( '<div class="wpv-setting-container"><p class="toolset-alert toolset-alert-error">%s</p></div>', $message ) );
}
/**
* wpv_dismiss_dialog
*
* Sets a dialog as dismissed for the current user
*
* @param $dialog (string) the ID for the dialog
*
* @since 1.7
*/
function wpv_dismiss_dialog( $dialog = '' ) {
$dialog = sanitize_key( $dialog );
if ( empty( $dialog ) ) {
return;
}
$user_id = get_current_user_id();
$dismissed_dialogs = get_user_meta( $user_id, '_wpv_dismissed_dialogs', true );
if ( ! is_array( $dismissed_dialogs ) || empty( $dismissed_dialogs ) ) {
$dismissed_dialogs = array();
}
$dismissed_dialogs[ $dialog ] = 'yes';
update_user_meta( $user_id, '_wpv_dismissed_dialogs', $dismissed_dialogs );
// Remove the old usermeta field that we used when displaying dialogs after parametric and pagination insertion
delete_user_meta( $user_id, 'wpv_view_editor_help_dismiss' );
}
/**
* wpv_dismiss_pointer
*
* Sets a pointer as dismissed for the current user
*
* @param $pointer (string) the ID for the pointer
*
* @since 1.7
*/
function wpv_dismiss_pointer( $pointer = '' ) {
$pointer = sanitize_key( $pointer );
if ( empty( $pointer ) ) {
return;
}
$user_id = get_current_user_id();
$dismissed_pointers = get_user_meta( $user_id, '_wpv_dismissed_pointers', true );
if ( ! is_array( $dismissed_pointers ) || empty( $dismissed_pointers ) ) {
$dismissed_pointers = array();
}
$dismissed_pointers[ $pointer ] = 'yes';
update_user_meta( $user_id, '_wpv_dismissed_pointers', $dismissed_pointers );
// Remove the old usermeta field that we used when displaying dialogs after parametric and pagination insertion
delete_user_meta( $user_id, 'wpv_view_editor_help_dismiss' );
}
/**
* wpv_get_the_archive_title
*
* Duplicate of WordPress 4.1+ get_the_archive_title()
*
* Link: https://developer.wordpress.org/reference/functions/get_the_archive_title/
*
* We provide our own function so as to decrease dependencies
*
* @since 1.8
*
* @return type string
*/
function wpv_get_the_archive_title() {
if ( is_category() ) {
$title = sprintf( __( 'Category: %s' ), single_cat_title( '', false ) );
} elseif ( is_tag() ) {
$title = sprintf( __( 'Tag: %s' ), single_tag_title( '', false ) );
} elseif ( is_author() ) {
$title = sprintf( __( 'Author: %s' ), '<span class="vcard">' . get_the_author() . '</span>' );
} elseif ( is_year() ) {
$title = sprintf( __( 'Year: %s' ), get_the_date( _x( 'Y', 'yearly archives date format' ) ) );
} elseif ( is_month() ) {
$title = sprintf( __( 'Month: %s' ), get_the_date( _x( 'F Y', 'monthly archives date format' ) ) );
} elseif ( is_day() ) {
$title = sprintf( __( 'Day: %s' ), get_the_date( _x( 'F j, Y', 'daily archives date format' ) ) );
} elseif ( is_tax( 'post_format' ) ) {
if ( is_tax( 'post_format', 'post-format-aside' ) ) {
$title = _x( 'Asides', 'post format archive title' );
} elseif ( is_tax( 'post_format', 'post-format-gallery' ) ) {
$title = _x( 'Galleries', 'post format archive title' );
} elseif ( is_tax( 'post_format', 'post-format-image' ) ) {
$title = _x( 'Images', 'post format archive title' );
} elseif ( is_tax( 'post_format', 'post-format-video' ) ) {
$title = _x( 'Videos', 'post format archive title' );
} elseif ( is_tax( 'post_format', 'post-format-quote' ) ) {
$title = _x( 'Quotes', 'post format archive title' );
} elseif ( is_tax( 'post_format', 'post-format-link' ) ) {
$title = _x( 'Links', 'post format archive title' );
} elseif ( is_tax( 'post_format', 'post-format-status' ) ) {
$title = _x( 'Statuses', 'post format archive title' );
} elseif ( is_tax( 'post_format', 'post-format-audio' ) ) {
$title = _x( 'Audio', 'post format archive title' );
} elseif ( is_tax( 'post_format', 'post-format-chat' ) ) {
$title = _x( 'Chats', 'post format archive title' );
}
} elseif ( is_post_type_archive() ) {
$title = sprintf( __( 'Archives: %s' ), post_type_archive_title( '', false ) );
} elseif ( is_tax() ) {
$tax = get_taxonomy( get_queried_object()->taxonomy );
/* translators: 1: Taxonomy singular name, 2: Current taxonomy term */
$title = sprintf( __( '%1$s: %2$s' ), $tax->labels->singular_name, single_term_title( '', false ) );
} else {
$title = __( 'Archives' );
}
return $title;
}
/**
* Safely retrieve a key from $_POST variable.
*
* This is a wrapper for wpv_get_from_array(). See that for more information.
*
* @param string $key See wpv_getarr().
* @param mixed $default See wpv_getarr().
* @param null|array $valid See wpv_getarr().
*
* @return mixed See wpv_getarr().
*
* @deprecated 2.7.0 Deprecating it in favor of "toolset_getpost".
*
* @since 1.8
* @since 2.7.0 Deprecating it in favor of "toolset_getpost".
*/
function wpv_getpost( $key, $default = '', $valid = null ) {
return wpv_getarr( $_POST, $key, $default, $valid );
}
/**
* Safely retrieve a key from $_GET variable.
*
* This is a wrapper for wpv_get_from_array(). See that for more information.
*
* @param string $key See wpv_getarr().
* @param mixed $default See wpv_getarr().
* @param null|array $valid See wpv_getarr().
*
* @return mixed See wpv_getarr().
*
* @deprecated 2.7.0 Deprecating it in favor of "toolset_getget".
*
* @since 1.8
* @since 2.7.0 Deprecating it in favor of "toolset_getget".
*/
function wpv_getget( $key, $default = '', $valid = null ) {
return wpv_getarr( $_GET, $key, $default, $valid );
}
/**
* Safely retrieve a key from given array (meant for $_POST, $_GET, etc).
*
* Checks if the key is set in the source array. If not, default value is returned. Optionally validates against array
* of allowed values and returns default value if the validation fails.
*
* @param array $source The source array.
* @param string $key The key to be retrieved from the source array.
* @param mixed $default Default value to be returned if key is not set or the value is invalid. Optional.
* Default is empty string.
* @param null|array $valid If an array is provided, the value will be validated against it's elements.
*
* @return mixed The value of the given key or $default.
*
* @deprecated 2.7.0 Deprecating it in favor of "toolset_getarr".
*
* @since 1.8
* @since 2.7.0 Deprecating it in favor of "toolset_getarr".
*/
function wpv_getarr( &$source, $key, $default = '', $valid = null ) {
if( isset( $source[ $key ] ) ) {
$val = $source[ $key ];
if( is_array( $valid ) && !in_array( $val, $valid ) ) {
return $default;
}
return $val;
} else {
return $default;
}
}
/**
* Retrieve a modified URL with query string, omitting empty query arguments.
*
* Behaves exactly like add_query_arg(), except that it omits arguments with
* value of empty string.
*
* @since 1.7
*
* @link http://codex.wordpress.org/Function_Reference/add_query_arg
*
* @param array $args Associative array of argument names and their values.
* @param string $url Existing URL.
* @param bool $esc_raw Optional. If true, esc_url_raw() will be used instead of esc_url() for the whole output.
*
* @return string New URL query string.
*/
function wpv_maybe_add_query_arg( $args, $url, $esc_raw = false ) {
foreach( $args as $key => $val ) {
if( '' === $val ) {
unset( $args[ $key ] );
}
}
$result = add_query_arg( $args, $url );
return $esc_raw ? esc_url_raw( $result ) : esc_url( $result );
}
/**
* array_merge_recursive does indeed merge arrays, but it converts values with duplicate
* keys to arrays rather than overwriting the value in the first array with the duplicate
* value in the second array, as array_merge does. I.e., with array_merge_recursive,
* this happens (documented behavior):
*
* array_merge_recursive(array('key' => 'org value'), array('key' => 'new value'));
* => array('key' => array('org value', 'new value'));
*
* array_merge_recursive_distinct does not change the datatypes of the values in the arrays.
* Matching keys' values in the second array overwrite those in the first array, as is the
* case with array_merge, i.e.:
*
* array_merge_recursive_distinct(array('key' => 'org value'), array('key' => 'new value'));
* => array('key' => array('new value'));
*
* Parameters are passed by reference, though only for performance reasons. They're not
* altered by this function.
*
* @param array $array1
* @param array $array2
* @return array
* @author Daniel <daniel (at) danielsmedegaardbuus (dot) dk>
* @author Gabriel Sobrinho <gabriel (dot) sobrinho (at) gmail (dot) com>
*/
function wpv_array_merge_recursive_distinct( array &$array1, array &$array2 ) {
$merged = $array1;
foreach ( $array2 as $key => &$value )
{
if ( is_array ( $value ) && isset ( $merged [$key] ) && is_array ( $merged [$key] ) )
{
$merged [$key] = wpv_array_merge_recursive_distinct ( $merged [$key], $value );
}
else
{
$merged [$key] = $value;
}
}
return $merged;
}
/**
* Shortcut function to dump variable content in an easily-readable way on a page.
*
* This is meant mainly for debugging purposes.
*
* @param mixed $value Variable to be dumped.
* @param null|string $title Optional title of the dump.
* @since 1.10
*/
function wpv_predump( $value, $title = null ) {
if( null != $title ) {
printf( '<strong>%s</strong><br />', $title );
}
echo '<pre>';
print_r( $value );
echo '</pre>';
}
/**
* Query the database for IDs of CT used as loop templates
* Note that we might be storing zero as this field value for no loop template assigned
*
* @return array Loop Content Template IDs or empty if none
*
* @since 1.10
*/
function wpv_get_loop_content_template_ids() {
static $loop_ct_ids = null;
if ( $loop_ct_ids === null ) {
global $wpdb;
$view_loop_template_key = '_view_loop_template';
$view_loop_template_not_set = '0';
$loop_ct_ids = $wpdb->get_col(
$wpdb->prepare(
"SELECT DISTINCT meta_value FROM {$wpdb->postmeta}
WHERE meta_key = %s
AND meta_value != %s
ORDER BY post_id",
$view_loop_template_key,
$view_loop_template_not_set
)
);
}
return $loop_ct_ids;
}
/**
* wpv_get_views_ajaxurl
*
* Create our own version of ajaxurl that forces a query argument, so we can be sure it exists
* From now on, we can use it in javascript as views_ajaxurl + '&foo=bar'
*
* @since 1.12
*/
function wpv_get_views_ajaxurl() {
// WordPress sites with admin over HTTPS (either natively or by using FORCE_SSL_ADMIN option) and frontend over HTTP
// expect that frontend AJAX calls to admin-ajax.php to be executed over HTTP. This is strange but it happens.
// The solution is to match the "admin-ajax.php" URL scheme with the scheme of the frontend.
$origin = admin_url( 'admin-ajax.php', ( is_ssl() ? 'https' : 'http' ) );
$query_args['wpv_force_one_query_arg'] = 'views';
$url = esc_url( add_query_arg(
$query_args,
$origin
) );
return $url;
}
/**
* Maybe flatten an array and return a string of the pieces, using a separator.
*
* This is a recursive function that can flatten any multidimmensional array.
*
* @param array|string $item The element to flatten.
* @param string $separator The separator to use.
*
* @return string
*
* @since 2.3.0
*/
function wpv_maybe_flatten_array( $item = array(), $separator = ', ' ) {
$flatten = '';
if ( is_array( $item ) ) {
foreach ( $item as $item_part ) {
$item_part_string = wpv_maybe_flatten_array( $item_part, $separator );
if ( $flatten != '' ) {
$flatten .= $separator;
}
$flatten .= $item_part_string;
}
} else {
$flatten = $item;
}
return $flatten;
}
/**
* Callback to restore the wpautop callback on the the_content filter.
*
* @see https://developer.wordpress.org/reference/functions/_restore_wpautop_hook/
* @param string $content
* @return string
* @since 3.2
* @access private
*/
function _wpv_restore_wpautop_hook( $content ) {
$current_priority = has_filter( 'the_content', '_wpv_restore_wpautop_hook' );
if ( false === $current_priority ) {
return $content;
}
add_filter( 'the_content', 'wpautop', $current_priority - 1 );
remove_filter( 'the_content', '_wpv_restore_wpautop_hook', $current_priority );
return $content;
}